home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload Trio 2 / Shareware Overload Trio Volume 2 (Chestnut CD-ROM).ISO / dir24 / mb1705.zip / RT.DOC < prev    next >
Text File  |  1994-04-23  |  7KB  |  222 lines
  1.    The RoundTable server for the G8BPQ switch.
  2.  
  3.    Requirements:
  4.  
  5.      Runs in a 30K DESQview window.
  6.      Uses it's own set of BPQ switch ports.
  7.      Has it's own node command.
  8.  
  9.    Getting started:
  10.  
  11.      First, configure the switch for RT.
  12.  
  13.      In the file BPQCFG.TXT, add the new application RT.
  14.      Note that it MUST be the fourth or later application.
  15.  
  16.      Example: APPLICATIONS=BBS,,,RT
  17.  
  18.      RT running at different nodes can be linked together, to form
  19.      a single roundtable.  If you wish to do this, add the
  20.      application *RTL in your BPQCFG.TXT
  21.  
  22.      Example: APPLICATIONS=BBS,,,RT,*RTL
  23.  
  24.      You will also have to increase the size of the RT Desqview
  25.      window to 57k.
  26.  
  27.      When RT is in use, it will automatically link to the RT servers running
  28.      at the specified nodes.
  29.      (Note:  RT must be running on both systems for this to work.)
  30.  
  31.      Add some ports to YTNC.
  32.      RT ports cannot be shared with other applications.
  33.  
  34.      Run BPQCFG and re-boot your system.
  35.  
  36.      Configure RT.  See the file RT.INI and the information below.
  37.  
  38.      RT.INI must be put in the directory specified by environment variable
  39.      RLICFG, if defined, otherwise in directory \BBS.
  40.  
  41.      Startup RT in a 57K DESQview window.
  42.  
  43.      Now anyone that wishes to use it can just connect to your node
  44.      and then issue the RT command.
  45.  
  46.      You can log in to RT locally with control-E.
  47.      Control-F shuts RT down.
  48.  
  49.      RT keeps track of user names and qth in file RT.USR, this file will be put
  50.      in the directory specified by environment variable RLIDB, if defined,
  51.      otherwise in directory \BBS.
  52.  
  53.      RT keeps a log in file RT.LOG, this file will be put
  54.      in the directory specified by environment variable RLILOG,
  55.      if defined, otherwise in directory \BBS.
  56.  
  57.  
  58.  
  59.                     (1)
  60.  
  61.  
  62. RT.INI
  63.  
  64. This initialization file is keyword driven in a similar fashion as ports.mb.
  65. The file consists of areas seperated by blank lines that define the different
  66. aspects of RT and how it will function.
  67.  
  68. BPQ Application area
  69.  
  70. RTAPPL:      5          (The BPQ application number as defined in BPQCFG.TXT
  71.                file for RT.  It must be greater than or = to 4.)
  72. RTLinkAPPL:  6          (The BPQ application number as defined in BPQCFG.TXT
  73.                file for *RTL.
  74.  
  75. COM PORT START AREA
  76.  
  77. COMstart:   10          (Defines the first com port to use for RT.  These ports
  78.                cannot be shared with other applications.
  79.  
  80. COM PORTS, TOPICS, NODES AND USERS
  81.  
  82. Maxports:    3          (The total number of allowed ports to be used for RT.
  83.                This number is dependent on how many available ports
  84.                are defined in the YTNC line, how many ports are being
  85.                used by the BBS and other applications.)
  86. MaxTopics:  10          (The number of potential topics that can run
  87.                similtaneously during an RT session.)
  88. MaxNodes:   30          (The maximum number of potential nodes that can be linked
  89.                in the Linked Round Table Session.)
  90. MaxUsers:   64          (The maximum number of users that can be connected to
  91.                the Linked Round Table Session for all nodes.)
  92.  
  93. SYSTEM TIMEOUT
  94.  
  95. Timeout:    600       (Timeout in seconds on non-activity before a user is
  96.                automatically disconnected from a RT session. This
  97.                number should be set to a sufficently high number
  98.                to allow for all links to be included.  Generally
  99.                with a small system of 1 or 2 nodes with a good path
  100.                240 seconds might be ok.  But with a large number of
  101.                nodes 600 seconds might be more appropriate.)
  102.  
  103. LINKS
  104.  
  105. Links:        Callsign Callsign etc
  106.               (Defines which nodes will be included in the Linked
  107.                Roundtable session. Note aliases may be used here
  108.                instead of callsigns.
  109.  
  110.                   (2)
  111.  
  112.  
  113. WINDOW ATTRIBUTES
  114.  
  115. Syntax: <Window Name:> <Foreground> <Background> <Cursor>
  116. Window names:  WinTop
  117.            WinMain
  118.            WinBottom
  119.  
  120. Foreground colors:
  121.  
  122.   BLACK BLUE GREEN CYAN RED MAGENTA BROWN LIGHTGREY DARKGREY LIGHTBLUE
  123.   LIGHTGREEN LIGHTCYAN LIGHTRED LIGHTMAGENTA YELLOW WHITE
  124.  
  125. Background colors:
  126.  
  127.   BLACK BLUE GREEN CYAN RED MAGENTA BROWN WHITE
  128.  
  129. Cursor types:
  130.  
  131.   NORMAL BLANK INSERT
  132.  
  133. Example:
  134.  
  135. Wintop:     White Red    Blank
  136. WinMain:    White Blue    Normal
  137. WinBottom:  Black White Insert
  138.  
  139. SOUNDS AND EVENTS
  140.  
  141. You can attach sounds to the various events that happen in the RT session.
  142. These sounds are in the form of tunes that can be written by the sysop using
  143. a 4 octave scale, setting tempos, note duration and rests.  The musical
  144. selection is defined in the RT.INI file as follows:
  145.  
  146. Tune:    Name of the tune
  147. Tempo:    The tempo that the tune will play at.  The lower the number the faster
  148.     the tune will play.
  149. Play:    defines the notes in <duration> <note> pairs
  150.  
  151. There is a maximum of 64 notes per tune.
  152.  
  153. The Scales - The scale in 4 octaves.  It starts at C0 and runs through G4 and
  154.          includes sharp notes.  The scale is as follows:
  155.  
  156.          C0 C0S D0 D0S E0 F0 F0S G0 G0S A0 A0S B0
  157.          C1 C1S D1 D1S E1 F1 F1S G1 G1S A1 A1S B1
  158.          C2 C2S D2 D2S E2 F2 F2S G2 G2S A2 A2S B2
  159.          C3 C3S D3 D3S E3 F3 F3S G3 G3S A3 A3S B3
  160.          C4 C4S D4 D4S E4 F4 F4S G4
  161.  
  162. Sample Tune:
  163.  
  164. Tune:    Green
  165. Tempo:    3
  166. Play:    2 E1 4 G1 2 A1 3 B1 1 C2S 2 B1 4 A1 2 F1S 4 D1
  167.  
  168.  
  169.                 (3)
  170.  
  171.  
  172. Events
  173.  
  174. There are 4 events that happen during the session.  They are Join, Leave,
  175. Link and Unlink.  Tunes can be attached to these events to notify the sysop
  176. that different things are happening during the RT session.
  177.  
  178. To attach tunes to the events use the syntax <Event name:> <Tune name>
  179.  
  180. For example:
  181.  
  182. Join:    TingTong
  183. Leave:    BingBong
  184. Link:    Alarm2
  185. Unlink: Clonk
  186.  
  187. Note: These tunes are included in the example RT.INI file with the release.
  188. Note: The user does not hear any of these tunes.
  189.  
  190. ROUND TABLE COMMANDS
  191.  
  192. There are 2 classes of commands.  There are the sysop only commands and the
  193. commands that are common to both the users and the sysop.  All commands are
  194. in the syntax </><COMMAND LETTER> [QUALIFER] except for sysop join and shut
  195. down of RT.  These are <cntrl E> and <cntrl f> respectively and are immediate
  196. actions.
  197.  
  198. Sysop Commands
  199.  
  200. /D <n>       -     Disconnect port n from the Round Table Session.
  201. /F       -     Force all links to be made as defined in the Link
  202.          list in RT.INI.
  203. /XT <Tune> -     Play a tune from the tune list in RT.INI.
  204. /XA <Window Name> <Foreground> <Background> <Cursor>
  205.          Change window attributes.
  206.  
  207. Common Commands
  208.  
  209. /H         -     Show the command list.
  210. /U         -     Show users.
  211. /N <name>     -     Enter your name.
  212. /Q <qth>     -     Enter your location.
  213. /T         -     Show topics during current session.
  214. /T <n>         -     Join a topic where <n> is the topic name.
  215. /T <name>     -     Create a new topic in the current session.
  216. /P         -     Show ports and links.
  217. /E         -     Toggle echo on and off.    Stops the echo of your text on
  218.                screen.    Defaults to on.
  219. /B         -     Leave Round Table and Return to node.
  220. /S <call> <Text> -     Send text to specific call only.
  221.  
  222.